<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OpenIG: Core-Base/Commands.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="openig_logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">OpenIG
   &#160;<span id="projectnumber">2.0.7</span>
   </div>
   <div id="projectbrief">cross-platform open-source OpenSceneGraph Image Generator</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_03afdc99cb57c147418d8186cf7c037f.html">Core-Base</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">Commands.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">//#******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">//#*</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">//#*      Copyright (C) 2015  Compro Computer Services</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">//#*      http://openig.compro.net</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">//#*</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">//#*      Source available at: https://github.com/CCSI-CSSI/MuseOpenIG</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">//#*</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">//#*      This software is released under the LGPL.</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">//#*</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">//#*   This software is free software; you can redistribute it and/or modify</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">//#*   it under the terms of the GNU Lesser General Public License as published</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">//#*   by the Free Software Foundation; either version 2.1 of the License, or</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">//#*   (at your option) any later version.</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">//#*</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">//#*   This software is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment">//#*   but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">//#*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">//#*   the GNU Lesser General Public License for more details.</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">//#*</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment">//#*   You should have received a copy of the GNU Lesser General Public License</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment">//#*   along with this library; if not, write to the Free Software</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">//#*   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">//#*</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment">//#*    Please direct any questions or comments to the OpenIG Forums</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment">//#*    Email address: openig@compro.net</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">//#*</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">//#*</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment">//#*    Please direct any questions or comments to the OpenIG Forums</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment">//#*    Email address: openig@compro.net</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">//#*</span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">//#*</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment">//#*****************************************************************************</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#ifndef COMMANDS_H</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="preprocessor">#define COMMANDS_H</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">#if defined(OPENIG_SDK)</span></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">    #include &lt;OpenIG-Base/StringUtils.h&gt;</span></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">    #include &lt;OpenIG-Base/Export.h&gt;</span></div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor">#else</span></div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="preprocessor">    #include &lt;Core-Base/StringUtils.h&gt;</span></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="preprocessor">    #include &lt;Core-Base/Export.h&gt;</span></div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="preprocessor">#include &lt;osg/ref_ptr&gt;</span></div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="preprocessor">#include &lt;osg/Referenced&gt;</span></div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespace_open_i_g.html">OpenIG</a> {</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    <span class="keyword">namespace </span>Base {</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="class_open_i_g_1_1_base_1_1_commands.html">   60</a></span>&#160;        <span class="keyword">class </span>IGCORE_EXPORT <a class="code" href="class_open_i_g_1_1_base_1_1_commands.html">Commands</a></div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;        {</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;        <span class="keyword">protected</span>:</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;            <a class="code" href="class_open_i_g_1_1_base_1_1_commands.html">Commands</a>();</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;            ~<a class="code" href="class_open_i_g_1_1_base_1_1_commands.html">Commands</a>();</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;        <span class="keyword">public</span>:</div><div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="class_open_i_g_1_1_base_1_1_commands_1_1_command.html">   86</a></span>&#160;            <span class="keyword">class </span><a class="code" href="class_open_i_g_1_1_base_1_1_commands_1_1_command.html">Command</a> : <span class="keyword">public</span> osg::Referenced</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;            {</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;            <span class="keyword">public</span>:</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;                <span class="keyword">virtual</span> <span class="keywordtype">int</span> exec(<span class="keyword">const</span> StringUtils::Tokens&amp; tokens) = 0;</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;                <span class="keyword">virtual</span> <span class="keyword">const</span> std::string getUsage() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;                <span class="keyword">virtual</span> <span class="keyword">const</span> std::string getDescription() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;</div><div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;                <span class="keyword">virtual</span> <span class="keyword">const</span> std::string getArgumentsFormat() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;            };</div><div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;</div><div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="struct_open_i_g_1_1_base_1_1_commands_1_1_command_exec_callback.html">  144</a></span>&#160;            <span class="keyword">struct </span><a class="code" href="struct_open_i_g_1_1_base_1_1_commands_1_1_command_exec_callback.html">CommandExecCallback</a> : <span class="keyword">public</span> osg::Referenced</div><div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;            {</div><div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;                <span class="keyword">virtual</span> <span class="keywordtype">void</span> operator()(<span class="keyword">const</span> std::string&amp; command) = 0;</div><div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;            };</div><div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;</div><div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;            <span class="keywordtype">void</span> setCommandExecCallback(<a class="code" href="struct_open_i_g_1_1_base_1_1_commands_1_1_command_exec_callback.html">CommandExecCallback</a>* callback);</div><div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;</div><div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;            <span class="keyword">static</span> <a class="code" href="class_open_i_g_1_1_base_1_1_commands.html">Commands</a>*    instance();</div><div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;</div><div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;            <span class="keywordtype">int</span>                 exec(<span class="keyword">const</span> std::string&amp; command);</div><div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;</div><div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;            <span class="keywordtype">void</span>                addCommand(<span class="keyword">const</span> std::string&amp; command, <a class="code" href="class_open_i_g_1_1_base_1_1_commands_1_1_command.html">Command</a>* cmd);</div><div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;</div><div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;            <span class="keywordtype">void</span>                loadScript(<span class="keyword">const</span> std::string&amp; fileName);</div><div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;</div><div class="line"><a name="l00201"></a><span class="lineno">  201</span>&#160;            <span class="keywordtype">void</span>                clear();</div><div class="line"><a name="l00202"></a><span class="lineno">  202</span>&#160;</div><div class="line"><a name="l00203"></a><span class="lineno">  203</span>&#160;            <span class="keyword">typedef</span> osg::ref_ptr&lt;Command&gt;                                           CommandPtr;</div><div class="line"><a name="l00204"></a><span class="lineno">  204</span>&#160;            <span class="keyword">typedef</span> std::map&lt;std::string, osg::ref_ptr&lt;Command&gt; &gt;                   CommandsMap;</div><div class="line"><a name="l00205"></a><span class="lineno">  205</span>&#160;            <span class="keyword">typedef</span> std::map&lt;std::string, osg::ref_ptr&lt;Command&gt; &gt;::iterator         CommandsMapIterator;</div><div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;            <span class="keyword">typedef</span> std::map&lt;std::string, osg::ref_ptr&lt;Command&gt; &gt;::const_iterator   CommandsMapConstIterator;</div><div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;</div><div class="line"><a name="l00215"></a><span class="lineno"><a class="line" href="class_open_i_g_1_1_base_1_1_commands.html#a7d3993f72827e33c498ecb1b5ee86912">  215</a></span>&#160;            <span class="keyword">const</span> CommandsMap&amp; <a class="code" href="class_open_i_g_1_1_base_1_1_commands.html#a7d3993f72827e33c498ecb1b5ee86912">getCommands</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00216"></a><span class="lineno">  216</span>&#160;<span class="keyword">            </span>{</div><div class="line"><a name="l00217"></a><span class="lineno">  217</span>&#160;                <span class="keywordflow">return</span> _commands;</div><div class="line"><a name="l00218"></a><span class="lineno">  218</span>&#160;            }</div><div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;</div><div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;            <span class="keywordtype">void</span> removeCommand(<span class="keyword">const</span> std::string&amp; command);</div><div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;</div><div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;        <span class="keyword">protected</span>:</div><div class="line"><a name="l00231"></a><span class="lineno"><a class="line" href="class_open_i_g_1_1_base_1_1_commands.html#a8297a7861178aed592e6cdc36e488df3">  231</a></span>&#160;            CommandsMap                         <a class="code" href="class_open_i_g_1_1_base_1_1_commands.html#a8297a7861178aed592e6cdc36e488df3">_commands</a>;</div><div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;</div><div class="line"><a name="l00234"></a><span class="lineno"><a class="line" href="class_open_i_g_1_1_base_1_1_commands.html#a69bf0f5716bfb3b284691e07943d761b">  234</a></span>&#160;            osg::ref_ptr&lt;CommandExecCallback&gt;   <a class="code" href="class_open_i_g_1_1_base_1_1_commands.html#a69bf0f5716bfb3b284691e07943d761b">_commandExecCallback</a>;</div><div class="line"><a name="l00235"></a><span class="lineno">  235</span>&#160;</div><div class="line"><a name="l00236"></a><span class="lineno">  236</span>&#160;        };</div><div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;    } <span class="comment">// namespace</span></div><div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;} <span class="comment">// namespace</span></div><div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;</div><div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;<span class="preprocessor">#endif // COMMANDS_H</span></div><div class="ttc" id="namespace_open_i_g_html"><div class="ttname"><a href="namespace_open_i_g.html">OpenIG</a></div><div class="ttdef"><b>Definition:</b> Animation.h:55</div></div>
<div class="ttc" id="class_open_i_g_1_1_base_1_1_commands_html_a7d3993f72827e33c498ecb1b5ee86912"><div class="ttname"><a href="class_open_i_g_1_1_base_1_1_commands.html#a7d3993f72827e33c498ecb1b5ee86912">OpenIG::Base::Commands::getCommands</a></div><div class="ttdeci">const CommandsMap &amp; getCommands() const</div><div class="ttdoc">Gives the current commands. </div><div class="ttdef"><b>Definition:</b> Commands.h:215</div></div>
<div class="ttc" id="class_open_i_g_1_1_base_1_1_commands_html"><div class="ttname"><a href="class_open_i_g_1_1_base_1_1_commands.html">OpenIG::Base::Commands</a></div><div class="ttdoc">The Commands singleton class. </div><div class="ttdef"><b>Definition:</b> Commands.h:60</div></div>
<div class="ttc" id="class_open_i_g_1_1_base_1_1_commands_html_a69bf0f5716bfb3b284691e07943d761b"><div class="ttname"><a href="class_open_i_g_1_1_base_1_1_commands.html#a69bf0f5716bfb3b284691e07943d761b">OpenIG::Base::Commands::_commandExecCallback</a></div><div class="ttdeci">osg::ref_ptr&lt; CommandExecCallback &gt; _commandExecCallback</div><div class="ttdoc">The command exec callback, executed when a command is executed. </div><div class="ttdef"><b>Definition:</b> Commands.h:234</div></div>
<div class="ttc" id="class_open_i_g_1_1_base_1_1_commands_1_1_command_html"><div class="ttname"><a href="class_open_i_g_1_1_base_1_1_commands_1_1_command.html">OpenIG::Base::Commands::Command</a></div><div class="ttdoc">The Command class. </div><div class="ttdef"><b>Definition:</b> Commands.h:86</div></div>
<div class="ttc" id="struct_open_i_g_1_1_base_1_1_commands_1_1_command_exec_callback_html"><div class="ttname"><a href="struct_open_i_g_1_1_base_1_1_commands_1_1_command_exec_callback.html">OpenIG::Base::Commands::CommandExecCallback</a></div><div class="ttdoc">Callback when command is executed. </div><div class="ttdef"><b>Definition:</b> Commands.h:144</div></div>
<div class="ttc" id="class_open_i_g_1_1_base_1_1_commands_html_a8297a7861178aed592e6cdc36e488df3"><div class="ttname"><a href="class_open_i_g_1_1_base_1_1_commands.html#a8297a7861178aed592e6cdc36e488df3">OpenIG::Base::Commands::_commands</a></div><div class="ttdeci">CommandsMap _commands</div><div class="ttdoc">name based std::map of commands added </div><div class="ttdef"><b>Definition:</b> Commands.h:231</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed May 16 2018 15:41:11 for OpenIG by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
